Skip to main content

SpriteEffect Class

Description:

  A class for creating SpriteEffect objects.

__call

Type: Metamethod.

Description:

  A metamethod that allows you to create a new SpriteEffect object.

Signature:

metamethod __call: function(self: SpriteEffectClass, vertShader: string, fragShader: string): SpriteEffect

Parameters:

ParameterTypeDescription
vertShaderstringThe vertex shader file string.
fragShaderstringThe fragment shader file string.
A shader file string must be one of the formats:
"builtin:" + theBuiltinShaderName
"Shader/compiled_shader_file.bin"

Returns:

Return TypeDescription
SpriteEffectA new SpriteEffect object.

__call

Type: Metamethod.

Description:

  A metamethod for creating a new empty SpriteEffect object.

Signature:

metamethod __call: function(self: SpriteEffectClass): SpriteEffect

Returns:

Return TypeDescription
SpriteEffectA new SpriteEffect object.